Keycloak REST Services 1.5.0-Final

Path: / admin / realms / {realm} / users / {id}

Get represenation of the user

Path parameters:
realm - realm name (not id!)
id -

Sub-Resources
Resources
NameDescription
consentsList set of consents granted by this user.
execute-actions-emailSend an email to the user with a link they can click to reset their password.
federated-identityList set of social logins associated with this user.
impersonation
logoutRemove all user sessions associated with this user.
remove-totp
reset-passwordSet up a temporary password for this user.
role-mappingsGet role mappings for this user
send-verify-emailSend an email to the user with a link they can click to verify their email address.
sessionsList set of sessions associated with this user.

Resource Methods
Method Summary
NameDescription
PUT /admin/realms/{realm}/users/{id}Update the user
GET /admin/realms/{realm}/users/{id}Get represenation of the user
DELETE /admin/realms/{realm}/users/{id}delete this user

Method Detail

PUT /admin/realms/{realm}/users/{id}

Update the user

HTTP Example:
PUT /admin/realms/{realm}/users/{id}
API Example:

UsersResource.updateUser({'realm': /* name realm name (not id!) */,
  'id': /* id */,
  '$entity': /* rep */});

Input:
UserRepresentation
Output:
Response -
Consumes:
application/json

GET /admin/realms/{realm}/users/{id}

Get represenation of the user

HTTP Example:
GET /admin/realms/{realm}/users/{id}
API Example:

UsersResource.getUser({'realm': /* name realm name (not id!) */,
  'id': /* id user id */});

Output:
UserRepresentation -
Produces:
application/json

DELETE /admin/realms/{realm}/users/{id}

delete this user

HTTP Example:
DELETE /admin/realms/{realm}/users/{id}
API Example:

UsersResource.deleteUser({'realm': /* name realm name (not id!) */,
  'id': /* id user id */});

Output:
Response

Keycloak REST Services 1.5.0-Final